LEADTOOLS Image Processing (Leadtools.ImageProcessing.Core assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
CorrelationCommand Constructor(RasterImage,LeadPoint[],Int32,Int32,Int32)
See Also  Example
Leadtools.ImageProcessing.Core Namespace > CorrelationCommand Class > CorrelationCommand Constructor : CorrelationCommand Constructor(RasterImage,LeadPoint[],Int32,Int32,Int32)



correlationImage
RasterImage object that references the image for which to search.
points
An array of Leadtools.LeadPoint structures. This array will be updated with the starting points for the correlated areas.
xStep
Step size in the X direction (along image width), in pixels. For best results, use 1. This parameter only accepts positive values.
yStep
Step size in the Y direction (along image height), in pixels. For best results, use 1. This parameter only accepts positive values.
threshold
Value that indicates the correlation threshold, which is a measure of association required to consider two areas to be correlated. If the correlation value between correlationImage and an area in the image to be searched (the Run method image) is less than the correlation threshold they are uncorrelated. Valid values range from 0 (zero resemblance) to 100 (perfect resemblance).
Initializes a new CorrelationCommand class object with explicit parameters. Supported in Silverlight, Windows Phone 7

Syntax

Visual Basic (Declaration) 
Public Function New( _
   ByVal correlationImage As RasterImage, _
   ByVal points() As LeadPoint, _
   ByVal xStep As Integer, _
   ByVal yStep As Integer, _
   ByVal threshold As Integer _
)
Visual Basic (Usage)Copy Code
Dim correlationImage As RasterImage
Dim points() As LeadPoint
Dim xStep As Integer
Dim yStep As Integer
Dim threshold As Integer
 
Dim instance As New CorrelationCommand(correlationImage, points, xStep, yStep, threshold)
C# 
public CorrelationCommand( 
   RasterImage correlationImage,
   LeadPoint[] points,
   int xStep,
   int yStep,
   int threshold
)
C++/CLI 
public:
CorrelationCommand( 
   RasterImage^ correlationImage,
   array<LeadPoint>^ points,
   int xStep,
   int yStep,
   int threshold
)

Parameters

correlationImage
RasterImage object that references the image for which to search.
points
An array of Leadtools.LeadPoint structures. This array will be updated with the starting points for the correlated areas.
xStep
Step size in the X direction (along image width), in pixels. For best results, use 1. This parameter only accepts positive values.
yStep
Step size in the Y direction (along image height), in pixels. For best results, use 1. This parameter only accepts positive values.
threshold
Value that indicates the correlation threshold, which is a measure of association required to consider two areas to be correlated. If the correlation value between correlationImage and an area in the image to be searched (the Run method image) is less than the correlation threshold they are uncorrelated. Valid values range from 0 (zero resemblance) to 100 (perfect resemblance).

Example

Run the CorrelationCommand on an image.

Visual BasicCopy Code
Public Sub CorrelationConstructorExample()
   Dim codecs As New RasterCodecs()
   codecs.ThrowExceptionsOnInvalidImages = True

   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Master.jpg"))

   ' Prepare the command
   Dim points() As LeadPoint
   ReDim points(89)

   Dim DstImage As RasterImage = leadImage.Clone()
   Dim command As CorrelationCommand = New CorrelationCommand(DstImage, points, 1, 1, 70)
   ' Apply the correlation filter.
   command.Run(leadImage)

   MessageBox.Show("The number of points are:" & command.NumberOfPoints.ToString())

End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class
C#Copy Code
public void CorrelationConstructorExample()
   {
      // Load an image
      RasterCodecs codecs = new RasterCodecs();
      codecs.ThrowExceptionsOnInvalidImages = true;

      RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Master.jpg"));

      // Prepare the command
      RasterImage dstImage = image.Clone();
      LeadPoint[] points = new LeadPoint[90];

      CorrelationCommand command = new CorrelationCommand(dstImage, points, 1, 1, 70);
      // Apply the correlation filter.
      command.Run(image);

      MessageBox.Show("The number of points are:" + command.NumberOfPoints.ToString());

   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}
SilverlightCSharpCopy Code
public void CorrelationConstructorExample(RasterImage image, Stream outStream)
{
   // Prepare the command
   RasterImage dstImage = image.Clone();
   LeadPoint [] points = new LeadPoint[90];
   CorrelationCommand command = new CorrelationCommand(dstImage, points, 1, 1, 70);
   // Apply the correlation filter.
   command.Run(image);
   Debug.WriteLine("The number of points are:" + command.NumberOfPoints.ToString());

   // Save result image
   RasterCodecs codecs = new RasterCodecs();
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24);
   image.Dispose();
}
SilverlightVBCopy Code
Public Sub CorrelationConstructorExample(ByVal image As RasterImage, ByVal outStream As Stream)
   ' Prepare the command
   Dim dstImage As RasterImage = image.Clone()
   Dim points As LeadPoint() = New LeadPoint(89){}
   Dim command As CorrelationCommand = New CorrelationCommand(dstImage, points, 1, 1, 70)
   ' Apply the correlation filter.
   command.Run(image)
   Debug.WriteLine("The number of points are:" & command.NumberOfPoints.ToString())

   ' Save result image
   Dim codecs As RasterCodecs = New RasterCodecs()
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24)
   image.Dispose()
End Sub

Requirements

Target Platforms: Silverlight 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)

See Also